Return

Edit Task: SetPossibility ResourceAmount

Description

The SetPossibility ResourceAmount attribute under EditTask defines the resource usage's fixed or rate amount for a single task possibility. This command does not change the rate of resource usage, only the amount (i.e., if a resource was set to be used at a rate of 10 Mb per minute, this command can only change the amount from 10 Mb to another number). If RateType is defined as FixedPlusRate, both FixedAmount and RateAmount should be provided, otherwise only one value is needed.

Parameters

ParameterDescription
PossibilityNameA string of text with a comma delimited list of resources in the possibility. Order is not required and the resource names should not be in quotes.
ResourceNameA string of text of the name of the resource that is being defined within the command.
FixedAmountA double value. This value is used in conjunction with the UsageType and RateType to determine how much change will occur to the resource capacity when assigned. Used only when RateType is Fixed or FixedPlusRate.
RateAmountA double value. This value is used in conjunction with the UsageType and RateType to determine how much change will occur to the resource capacity when assigned. Used only when RateType is Rate or FixedPlusRate.

Examples

Change the resource usage amount to 20 for ResB in the possibility that uses ResA, ResB and ResC

PATCH api/task/TaskA

Body:

{

"SetResourceDetails" : {

"PossibilityName" : "ResA,ResB,ResC",

"Resource" : "ResB",

"ResourceAmount" : {

"FixedAmount" : "20" }

}

}